/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.web.context;

import org.springframework.boot.web.server.WebServer;
import org.springframework.context.ApplicationContext;
import org.springframework.util.ObjectUtils;

/**
 * 接口，应由创建和管理嵌入式{@link WebServer}生命周期的
 * {@link ApplicationContext 应用程序上下文}来实现。
 * @author Phillip Webb
 * @since 2.0.0
 */
public interface WebServerApplicationContext extends ApplicationContext {

	/**
	 * 返回由上下文创建的{@link WebServer}，如果服务器尚未创建则返回{@code null}。
	 * @return Web服务器
	 */
	WebServer getWebServer();

	/**
	 * 返回Web服务器应用程序上下文的命名空间，如果没有设置命名空间则返回{@code null}。
	 * 当多个Web服务器在同一个应用程序中运行时用于消歧义（例如，管理上下文在不同端口上运行）。
	 * @return 服务器命名空间
	 */
	String getServerNamespace();

	/**
	 * 如果指定的上下文是具有匹配服务器命名空间的{@link WebServerApplicationContext}，
	 * 则返回{@code true}。
	 * @param context 要检查的上下文
	 * @param serverNamespace 要匹配的服务器命名空间
	 * @return 如果上下文的服务器命名空间匹配则返回{@code true}
	 * @since 2.1.8
	 */
	static boolean hasServerNamespace(ApplicationContext context, String serverNamespace) {
		return (context instanceof WebServerApplicationContext) && ObjectUtils
				.nullSafeEquals(((WebServerApplicationContext) context).getServerNamespace(), serverNamespace);
	}

	/**
	 * 如果指定的上下文是{@link WebServerApplicationContext}，则返回服务器命名空间。
	 * @param context 上下文
	 * @return 服务器命名空间，如果上下文不是{@link WebServerApplicationContext}则返回{@code null}
	 * @since 2.6.0
	 */
	static String getServerNamespace(ApplicationContext context) {
		return (context instanceof WebServerApplicationContext)
				? ((WebServerApplicationContext) context).getServerNamespace() : null;

	}

}
